-
Notifications
You must be signed in to change notification settings - Fork 264
Add documentation for Spring boot integration #3713
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
||
## Configure Workers {#configure-workers} | ||
|
||
Temporal's Spring Boot integration supports two ways to configure workers auto-discovery and an explicit configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There should probably be a comma or semi colon in this sentence
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I made some suggestions for improvement, most of which relate to spelling, punctuation, and style conformance.
|
||
## Connect {#connect} | ||
|
||
To create an autoconfigured `WorkflowClient` all you have to do is specify some connection details in your `application.yml`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To create an autoconfigured `WorkflowClient` all you have to do is specify some connection details in your `application.yml`. | |
To create an autoconfigured `WorkflowClient`, you need only specify some connection details in your `application.yml` file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"specify some connection details" -- will it be obvious to the reader which ones they'll need to specify?
Looking at the application.yaml
file for the basic example in samples-java, it seems that the user must specify the Namespace name and the target (endpoint address of the frontend). Perhaps it's the case that the values shown there are the defaults, but shown explicitly to make it easier for someone to change.
I would recommend that this documentation on Spring Boot provides some more guidance about what one must set, either by including it here or linking to some existing resource that already provides it.
Finally, I'll note that this section refers to an application.yml
file, while the example I linked to refers to application.yaml
. Maybe that doesn't matter, but I wanted to point out the discrepancy.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
UPDATE: It appears that the explanation I was looking is in the next section. In this case, consider expanding "specify some connection details in your application.yml
file." to "specify some connection details in your application.yml
file, as described in the next section."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, let me know how it is now
Co-authored-by: Tom Wheeler <[email protected]>
Co-authored-by: Tom Wheeler <[email protected]>
What does this PR do?
Add documentation for Spring boot integration
https://github.com/temporalio/sdk-java/tree/master/temporal-spring-boot-autoconfigure
Notes to reviewers